Skip to main content
POST
/
v1
/
customers
/
{id}
/
credits
/
{productId}
/
usage
Create credits usage
curl --request POST \
  --url https://api.hyperline.co/v1/customers/{id}/credits/{productId}/usage \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "usage_retained": 41,
  "event_id": "<string>"
}
'
{
  "id": "cdt_BPZ19obsBS2qyo",
  "product_id": "itm_3kXODDF42QXtnL",
  "price": {
    "id": "pri_0Jv8EbMDOGsHcn",
    "amount": 20000,
    "pack_size": 120
  },
  "customer_id": "cus_Typ0px2W0aiEtl",
  "payment_method_id": "pm_1xMpj5bwRqN7LM",
  "invoice_id": "inv_1eTaiytfA0i2Va",
  "event_id": null,
  "expires_at": null,
  "type": "topup",
  "source": "api",
  "amount_excluding_tax": 123,
  "credit_count": 32,
  "balance_after": 2000,
  "created_at": "2024-10-13T07:00:01.860Z",
  "updated_at": "2024-10-13T07:00:01.860Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required
​
productId
string
required

Body

application/json

Credit usage entry payload

​
usage_retained
number
required

Value indicating the number of credits consumed.

Example:

41

​
event_id
string

Event ID corresponding to the credit consumption.

Response

201 - application/json

The created credit transaction

​
id
string
required

Credit transaction ID.

Example:

"cdt_BPZ19obsBS2qyo"

​
product_id
string | null
required

ID of the product related to the transaction.

Example:

"itm_3kXODDF42QXtnL"

​
price
object
required

Price details related to the transaction.

Example:
{
  "id": "pri_0Jv8EbMDOGsHcn",
  "amount": 20000,
  "pack_size": 120
}
​
customer_id
string
required

ID of the customer related to the transaction.

Example:

"cus_Typ0px2W0aiEtl"

​
payment_method_id
string | null
required

ID of the payment method related to the transaction.

Example:

"pm_1xMpj5bwRqN7LM"

​
invoice_id
string | null
required

ID of the invoice related to the transaction.

Example:

"inv_1eTaiytfA0i2Va"

​
event_id
string | null
required

ID of the event related to the credit consumption.

Example:

null

​
expires_at
string<date> | null
required

Expiration date for credits linked to this transaction

Example:

null

​
type
enum<string>
required

Type of credit transaction.

Available options:
topup,
usage,
expiration
Example:

"topup"

​
source
enum<string>
required

Type of credit transaction.

Available options:
app,
portal,
api,
system
Example:

"api"

​
amount_excluding_tax
number | null
required

Monetary amount. Expressed in currency's smallest unit.

​
credit_count
number
required

Value of credits related to the transaction.

Example:

32

​
balance_after
number
required

Credit balance after the transaction.

Example:

2000

​
created_at
string<date-time>
required

Credit transaction creation date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T07:00:01.860Z"

​
updated_at
string<date-time>
required

Credit transaction last edition date. UTC date time string in the ISO 8601 format.

Example:

"2024-10-13T07:00:01.860Z"